/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / C / Applications / Python 1.3 / source code / Doc / libtemplate.tex

< prev

next >

MacOS 8.1

Win98

DOS

browse contents

view JSON data

view as text

+--------+-------------------------+-------------------------+--------+--------+
|00000000| 25 20 54 65 6d 70 6c 61 | 74 65 20 66 6f 72 20 61 |% Templa|te for a|
|00000010| 20 6c 69 62 72 61 72 79 | 20 6d 61 6e 75 61 6c 20 | library| manual |
|00000020| 73 65 63 74 69 6f 6e 2e | 0d 25 20 50 4c 45 41 53 |section.|.% PLEAS|
|00000030| 45 20 52 45 4d 4f 56 45 | 20 54 48 45 20 43 4f 4d |E REMOVE| THE COM|
|00000040| 4d 45 4e 54 53 20 41 46 | 54 45 52 20 55 53 49 4e |MENTS AF|TER USIN|
|00000050| 47 20 54 48 45 20 54 45 | 4d 50 4c 41 54 45 0d 0d |G THE TE|MPLATE..|
|00000060| 0d 25 20 3d 3d 3d 3d 20 | 31 2e 20 3d 3d 3d 3d 0d |.% ==== |1. ====.|
|00000070| 25 20 43 68 6f 6f 73 65 | 20 6f 6e 65 20 6f 66 20 |% Choose| one of |
|00000080| 74 68 65 20 66 6f 6c 6c | 6f 77 69 6e 67 20 73 65 |the foll|owing se|
|00000090| 63 74 69 6f 6e 20 68 65 | 61 64 65 72 73 20 61 6e |ction he|aders an|
|000000a0| 64 20 69 6e 64 65 78 20 | 65 6e 74 72 69 65 73 3b |d index |entries;|
|000000b0| 0d 25 20 5c 73 65 63 74 | 69 6f 6e 7b 7d 20 67 65 |.% \sect|ion{} ge|
|000000c0| 6e 65 72 61 74 65 73 20 | 74 68 65 20 73 65 63 74 |nerates |the sect|
|000000d0| 69 6f 6e 20 68 65 61 64 | 65 72 2c 0d 25 20 5c 62 |ion head|er,.% \b|
|000000e0| 69 6d 6f 64 69 6e 64 65 | 78 7b 7d 20 6f 72 20 5c |imodinde|x{} or \|
|000000f0| 73 74 6d 6f 64 75 6e 64 | 65 78 7b 7d 20 67 65 6e |stmodund|ex{} gen|
|00000100| 65 72 61 74 65 73 20 61 | 6e 20 69 6e 64 65 78 20 |erates a|n index |
|00000110| 65 6e 74 72 79 20 66 6f | 72 20 74 68 69 73 20 6d |entry fo|r this m|
|00000120| 6f 64 75 6c 65 0d 0d 5c | 73 65 63 74 69 6f 6e 7b |odule..\|section{|
|00000130| 42 75 69 6c 74 2d 69 6e | 20 4d 6f 64 75 6c 65 20 |Built-in| Module |
|00000140| 5c 73 65 63 74 63 6f 64 | 65 7b 73 70 61 6d 7d 7d |\sectcod|e{spam}}|
|00000150| 09 25 20 49 66 20 69 6d | 70 6c 65 6d 65 6e 74 65 |.% If im|plemente|
|00000160| 64 20 69 6e 20 43 0d 5c | 62 69 6d 6f 64 69 6e 64 |d in C.\|bimodind|
|00000170| 65 78 7b 73 70 61 6d 7d | 0d 0d 5c 73 65 63 74 69 |ex{spam}|..\secti|
|00000180| 6f 6e 7b 53 74 61 6e 64 | 61 72 64 20 6d 6f 64 75 |on{Stand|ard modu|
|00000190| 6c 65 20 5c 73 65 63 74 | 63 6f 64 65 7b 73 70 61 |le \sect|code{spa|
|000001a0| 6d 7d 7d 09 25 20 49 66 | 20 69 6d 70 6c 65 6d 65 |m}}.% If| impleme|
|000001b0| 6e 74 65 64 20 69 6e 20 | 50 79 74 68 6f 6e 0d 5c |nted in |Python.\|
|000001c0| 73 74 6d 6f 64 69 6e 64 | 65 78 7b 73 70 61 6d 7d |stmodind|ex{spam}|
|000001d0| 0d 0d 0d 25 20 3d 3d 3d | 3d 20 32 2e 20 3d 3d 3d |...% ===|= 2. ===|
|000001e0| 3d 0d 25 20 47 69 76 65 | 20 61 20 73 68 6f 72 74 |=.% Give| a short|
|000001f0| 20 6f 76 65 72 76 69 65 | 77 20 6f 66 20 77 68 61 | overvie|w of wha|
|00000200| 74 20 74 68 65 20 6d 6f | 64 75 6c 65 20 64 6f 65 |t the mo|dule doe|
|00000210| 73 2e 0d 25 20 49 66 20 | 69 74 20 69 73 20 70 6c |s..% If |it is pl|
|00000220| 61 74 66 6f 72 6d 20 73 | 70 65 63 69 66 69 63 2c |atform s|pecific,|
|00000230| 20 6d 65 6e 74 69 6f 6e | 20 74 68 69 73 2e 0d 25 | mention| this..%|
|00000240| 20 4d 65 6e 74 69 6f 6e | 20 6f 74 68 65 72 20 69 | Mention| other i|
|00000250| 6d 70 6f 72 74 61 6e 74 | 20 72 65 73 74 72 69 63 |mportant| restric|
|00000260| 74 69 6f 6e 73 20 6f 72 | 20 67 65 6e 65 72 61 6c |tions or| general|
|00000270| 20 6f 70 65 72 61 74 69 | 6e 67 20 70 72 69 6e 63 | operati|ng princ|
|00000280| 69 70 6c 65 73 2e 0d 25 | 20 46 6f 72 20 65 78 61 |iples..%| For exa|
|00000290| 6d 70 6c 65 3a 0d 0d 54 | 68 65 20 5c 63 6f 64 65 |mple:..T|he \code|
|000002a0| 7b 73 70 61 6d 7d 20 6d | 6f 64 75 6c 65 20 64 65 |{spam} m|odule de|
|000002b0| 66 69 6e 65 73 20 6f 70 | 65 72 61 74 69 6f 6e 73 |fines op|erations|
|000002c0| 20 66 6f 72 20 68 61 6e | 64 6c 69 6e 67 20 63 61 | for han|dling ca|
|000002d0| 6e 73 20 6f 66 20 53 70 | 61 6d 2e 0d 49 74 20 6b |ns of Sp|am..It k|
|000002e0| 6e 6f 77 73 20 74 68 65 | 20 66 6f 75 72 20 67 65 |nows the| four ge|
|000002f0| 6e 65 72 61 6c 6c 79 20 | 61 76 61 69 6c 61 62 6c |nerally |availabl|
|00000300| 65 20 53 70 61 6d 20 76 | 61 72 69 65 74 69 65 73 |e Spam v|arieties|
|00000310| 20 61 6e 64 20 75 6e 64 | 65 72 73 74 61 6e 64 73 | and und|erstands|
|00000320| 0d 62 6f 74 68 20 63 61 | 6e 20 73 69 7a 65 73 2e |.both ca|n sizes.|
|00000330| 0d 0d 42 65 63 61 75 73 | 65 20 73 70 61 6d 69 66 |..Becaus|e spamif|
|00000340| 69 63 61 74 69 6f 6e 20 | 72 65 71 75 69 72 65 73 |ication |requires|
|00000350| 20 55 4e 49 58 20 70 72 | 6f 63 65 73 73 20 6d 61 | UNIX pr|ocess ma|
|00000360| 6e 61 67 65 6d 65 6e 74 | 2c 20 74 68 65 20 6d 6f |nagement|, the mo|
|00000370| 64 75 6c 65 20 69 73 0d | 6f 6e 6c 79 20 61 76 61 |dule is.|only ava|
|00000380| 69 6c 61 62 6c 65 20 6f | 6e 20 67 65 6e 75 69 6e |ilable o|n genuin|
|00000390| 65 20 55 4e 49 58 20 73 | 79 73 74 65 6d 73 2e 0d |e UNIX s|ystems..|
|000003a0| 0d 0d 25 20 3d 3d 3d 3d | 20 33 2e 20 3d 3d 3d 3d |..% ====| 3. ====|
|000003b0| 0d 25 20 4c 69 73 74 20 | 74 68 65 20 70 75 62 6c |.% List |the publ|
|000003c0| 69 63 20 66 75 6e 63 74 | 69 6f 6e 73 20 64 65 66 |ic funct|ions def|
|000003d0| 69 6e 65 64 20 62 79 20 | 74 68 65 20 6d 6f 64 75 |ined by |the modu|
|000003e0| 6c 65 2e 20 20 42 65 67 | 69 6e 20 77 69 74 68 20 |le.  Beg|in with |
|000003f0| 61 0d 25 20 73 74 61 6e | 64 61 72 64 20 70 68 72 |a.% stan|dard phr|
|00000400| 61 73 65 2e 20 20 59 6f | 75 20 6d 61 79 20 61 6c |ase.  Yo|u may al|
|00000410| 73 6f 20 6c 69 73 74 20 | 74 68 65 20 65 78 63 65 |so list |the exce|
|00000420| 70 74 69 6f 6e 73 20 61 | 6e 64 20 6f 74 68 65 72 |ptions a|nd other|
|00000430| 20 64 61 74 61 0d 25 20 | 69 74 65 6d 73 20 64 65 | data.% |items de|
|00000440| 66 69 6e 65 64 20 69 6e | 20 74 68 65 20 6d 6f 64 |fined in| the mod|
|00000450| 75 6c 65 2c 20 69 6e 73 | 6f 66 61 72 20 61 73 20 |ule, ins|ofar as |
|00000460| 74 68 65 79 20 61 72 65 | 20 69 6d 70 6f 72 74 61 |they are| importa|
|00000470| 6e 74 20 66 6f 72 20 74 | 68 65 0d 25 20 75 73 65 |nt for t|he.% use|
|00000480| 72 2e 0d 0d 54 68 65 20 | 5c 63 6f 64 65 7b 73 70 |r...The |\code{sp|
|00000490| 61 6d 7d 20 6d 6f 64 75 | 6c 65 20 64 65 66 69 6e |am} modu|le defin|
|000004a0| 65 73 20 74 68 65 20 66 | 6f 6c 6c 6f 77 69 6e 67 |es the f|ollowing|
|000004b0| 20 66 75 6e 63 74 69 6f | 6e 73 3a 0d 0d 25 20 2d | functio|ns:..% -|
|000004c0| 2d 2d 2d 20 33 2e 31 2e | 20 2d 2d 2d 2d 0d 25 20 |--- 3.1.| ----.% |
|000004d0| 52 65 64 65 66 69 6e 65 | 20 74 68 65 20 60 60 69 |Redefine| the ``i|
|000004e0| 6e 64 65 78 73 75 62 69 | 74 65 6d 27 27 20 6d 61 |ndexsubi|tem'' ma|
|000004f0| 63 72 6f 20 74 6f 20 70 | 6f 69 6e 74 20 74 6f 20 |cro to p|oint to |
|00000500| 74 68 69 73 20 6d 6f 64 | 75 6c 65 0d 25 20 28 61 |this mod|ule.% (a|
|00000510| 6c 74 65 72 6e 61 74 69 | 76 65 6c 79 2c 20 79 6f |lternati|vely, yo|
|00000520| 75 20 63 61 6e 20 70 75 | 74 20 74 68 69 73 20 61 |u can pu|t this a|
|00000530| 74 20 74 68 65 20 74 6f | 70 20 6f 66 20 74 68 65 |t the to|p of the|
|00000540| 20 66 69 6c 65 29 3a 0d | 0d 5c 72 65 6e 65 77 63 | file):.|.\renewc|
|00000550| 6f 6d 6d 61 6e 64 7b 5c | 69 6e 64 65 78 73 75 62 |ommand{\|indexsub|
|00000560| 69 74 65 6d 7d 7b 28 69 | 6e 20 6d 6f 64 75 6c 65 |item}{(i|n module|
|00000570| 20 73 70 61 6d 29 7d 0d | 0d 25 20 2d 2d 2d 2d 20 | spam)}.|.% ---- |
|00000580| 33 2e 32 2e 20 2d 2d 2d | 2d 0d 25 20 46 6f 72 20 |3.2. ---|-.% For |
|00000590| 65 61 63 68 20 66 75 6e | 63 74 69 6f 6e 2c 20 75 |each fun|ction, u|
|000005a0| 73 65 20 61 20 60 60 66 | 75 6e 63 64 65 73 63 27 |se a ``f|uncdesc'|
|000005b0| 27 20 62 6c 6f 63 6b 2e | 20 20 54 68 69 73 20 68 |' block.|  This h|
|000005c0| 61 73 20 65 78 61 63 74 | 6c 79 20 74 77 6f 0d 25 |as exact|ly two.%|
|000005d0| 20 70 61 72 61 6d 65 74 | 65 72 73 20 28 65 61 63 | paramet|ers (eac|
|000005e0| 68 20 70 61 72 61 6d 65 | 74 65 72 73 20 69 73 20 |h parame|ters is |
|000005f0| 63 6f 6e 74 61 69 6e 65 | 64 20 69 6e 20 61 20 73 |containe|d in a s|
|00000600| 65 74 20 6f 66 20 63 75 | 72 6c 79 20 62 72 61 63 |et of cu|rly brac|
|00000610| 65 73 29 3a 0d 25 20 74 | 68 65 20 66 69 72 73 74 |es):.% t|he first|
|00000620| 20 70 61 72 61 6d 65 74 | 65 72 20 69 73 20 74 68 | paramet|er is th|
|00000630| 65 20 66 75 6e 63 74 69 | 6f 6e 20 6e 61 6d 65 20 |e functi|on name |
|00000640| 28 74 68 69 73 20 61 75 | 74 6f 6d 61 74 69 63 61 |(this au|tomatica|
|00000650| 6c 6c 79 0d 25 20 67 65 | 6e 65 72 61 74 65 73 20 |lly.% ge|nerates |
|00000660| 61 6e 20 69 6e 64 65 78 | 20 65 6e 74 72 79 29 3b |an index| entry);|
|00000670| 20 74 68 65 20 73 65 63 | 6f 6e 64 20 70 61 72 61 | the sec|ond para|
|00000680| 6d 65 74 65 72 20 69 73 | 20 74 68 65 20 66 75 6e |meter is| the fun|
|00000690| 63 74 69 6f 6e 27 73 0d | 25 20 61 72 67 75 6d 65 |ction's.|% argume|
|000006a0| 6e 74 20 6c 69 73 74 2e | 20 20 49 66 20 74 68 65 |nt list.|  If the|
|000006b0| 72 65 20 61 72 65 20 6e | 6f 20 61 72 67 75 6d 65 |re are n|o argume|
|000006c0| 6e 74 73 2c 20 75 73 65 | 20 61 6e 20 65 6d 70 74 |nts, use| an empt|
|000006d0| 79 20 70 61 69 72 20 6f | 66 0d 25 20 63 75 72 6c |y pair o|f.% curl|
|000006e0| 79 20 62 72 61 63 65 73 | 2e 20 20 49 66 20 74 68 |y braces|.  If th|
|000006f0| 65 72 65 20 69 73 20 6d | 6f 72 65 20 74 68 61 6e |ere is m|ore than|
|00000700| 20 6f 6e 65 20 61 72 67 | 75 6d 65 6e 74 2c 20 73 | one arg|ument, s|
|00000710| 65 70 61 72 61 74 65 20 | 74 68 65 0d 25 20 61 72 |eparate |the.% ar|
|00000720| 67 75 6d 65 6e 74 73 20 | 77 69 74 68 20 62 61 63 |guments |with bac|
|00000730| 6b 73 6c 61 73 68 2d 63 | 6f 6d 6d 61 2e 20 20 4f |kslash-c|omma.  O|
|00000740| 70 74 69 6f 6e 61 6c 20 | 70 61 72 74 73 20 6f 66 |ptional |parts of|
|00000750| 20 74 68 65 20 70 61 72 | 61 6d 65 74 65 72 0d 25 | the par|ameter.%|
|00000760| 20 6c 69 73 74 20 61 72 | 65 20 63 6f 6e 74 61 69 | list ar|e contai|
|00000770| 6e 65 64 20 69 6e 20 5c | 6f 70 74 69 6f 6e 61 6c |ned in \|optional|
|00000780| 7b 2e 2e 2e 7d 20 28 74 | 68 69 73 20 67 65 6e 65 |{...} (t|his gene|
|00000790| 72 61 74 65 73 20 61 20 | 73 65 74 20 6f 66 20 73 |rates a |set of s|
|000007a0| 71 75 61 72 65 0d 25 20 | 62 72 61 63 6b 65 74 73 |quare.% |brackets|
|000007b0| 20 61 72 6f 75 6e 64 20 | 69 74 73 20 70 61 72 61 | around |its para|
|000007c0| 6d 65 74 65 72 29 2e 20 | 20 41 72 67 75 6d 65 6e |meter). | Argumen|
|000007d0| 74 73 20 61 72 65 20 61 | 75 74 6f 6d 61 74 69 63 |ts are a|utomatic|
|000007e0| 61 6c 6c 79 20 73 65 74 | 20 69 6e 0d 25 20 69 74 |ally set| in.% it|
|000007f0| 61 6c 69 63 73 20 69 6e | 20 74 68 65 20 70 61 72 |alics in| the par|
|00000800| 61 6d 65 74 65 72 20 6c | 69 73 74 2e 20 20 45 61 |ameter l|ist.  Ea|
|00000810| 63 68 20 61 72 67 75 6d | 65 6e 74 20 73 68 6f 75 |ch argum|ent shou|
|00000820| 6c 64 20 62 65 20 6d 65 | 6e 74 69 6f 6e 65 64 20 |ld be me|ntioned |
|00000830| 61 74 0d 25 20 6c 65 61 | 73 74 20 6f 6e 63 65 20 |at.% lea|st once |
|00000840| 69 6e 20 74 68 65 20 64 | 65 73 63 72 69 70 74 69 |in the d|escripti|
|00000850| 6f 6e 3b 20 65 61 63 68 | 20 75 73 61 67 65 20 28 |on; each| usage (|
|00000860| 65 76 65 6e 20 69 6e 73 | 69 64 65 20 5c 63 6f 64 |even ins|ide \cod|
|00000870| 65 7b 2e 2e 2e 7d 29 0d | 25 20 73 68 6f 75 6c 64 |e{...}).|% should|
|00000880| 20 62 65 20 65 6e 63 6c | 6f 73 65 64 20 69 6e 20 | be encl|osed in |
|00000890| 5c 76 61 72 7b 2e 2e 2e | 7d 2e 0d 0d 5c 62 65 67 |\var{...|}...\beg|
|000008a0| 69 6e 7b 66 75 6e 63 64 | 65 73 63 7d 7b 6f 70 65 |in{funcd|esc}{ope|
|000008b0| 6e 7d 7b 66 69 6c 65 6e | 61 6d 65 5c 6f 70 74 69 |n}{filen|ame\opti|
|000008c0| 6f 6e 61 6c 7b 5c 2c 20 | 6d 6f 64 65 5c 2c 20 62 |onal{\, |mode\, b|
|000008d0| 75 66 66 65 72 73 69 7a | 65 7d 7d 0d 4f 70 65 6e |uffersiz|e}}.Open|
|000008e0| 20 74 68 65 20 66 69 6c | 65 20 5c 76 61 72 7b 66 | the fil|e \var{f|
|000008f0| 69 6c 65 6e 61 6d 65 7d | 20 61 73 20 61 20 63 61 |ilename}| as a ca|
|00000900| 6e 20 6f 66 20 53 70 61 | 6d 2e 20 20 54 68 65 20 |n of Spa|m.  The |
|00000910| 6f 70 74 69 6f 6e 61 6c | 0d 5c 76 61 72 7b 6d 6f |optional|.\var{mo|
|00000920| 64 65 7d 20 61 6e 64 20 | 5c 76 61 72 7b 62 75 66 |de} and |\var{buf|
|00000930| 66 65 72 73 69 7a 65 7d | 20 61 72 67 75 6d 65 6e |fersize}| argumen|
|00000940| 74 73 20 73 70 65 63 69 | 66 79 20 74 68 65 20 72 |ts speci|fy the r|
|00000950| 65 61 64 2d 77 72 69 74 | 65 20 6d 6f 64 65 0d 28 |ead-writ|e mode.(|
|00000960| 5c 63 6f 64 65 7b 27 72 | 27 7d 20 28 64 65 66 61 |\code{'r|'} (defa|
|00000970| 75 6c 74 29 20 6f 72 20 | 5c 63 6f 64 65 7b 27 77 |ult) or |\code{'w|
|00000980| 27 7d 29 20 61 6e 64 20 | 74 68 65 20 62 75 66 66 |'}) and |the buff|
|00000990| 65 72 20 73 69 7a 65 20 | 28 64 65 66 61 75 6c 74 |er size |(default|
|000009a0| 3a 0d 73 79 73 74 65 6d | 20 64 65 70 65 6e 64 65 |:.system| depende|
|000009b0| 6e 74 29 2e 0d 5c 65 6e | 64 7b 66 75 6e 63 64 65 |nt)..\en|d{funcde|
|000009c0| 73 63 7d 0d 0d 25 20 2d | 2d 2d 2d 20 33 2e 33 2e |sc}..% -|--- 3.3.|
|000009d0| 20 2d 2d 2d 2d 0d 25 20 | 44 61 74 61 20 69 74 65 | ----.% |Data ite|
|000009e0| 6d 73 20 61 72 65 20 64 | 65 73 63 72 69 62 65 64 |ms are d|escribed|
|000009f0| 20 75 73 69 6e 67 20 61 | 20 60 60 64 61 74 61 64 | using a| ``datad|
|00000a00| 65 73 63 27 27 20 62 6c | 6f 63 6b 2e 20 20 54 68 |esc'' bl|ock.  Th|
|00000a10| 69 73 20 68 61 73 20 6f | 6e 6c 79 0d 25 20 6f 6e |is has o|nly.% on|
|00000a20| 65 20 70 61 72 61 6d 65 | 74 65 72 3a 20 74 68 65 |e parame|ter: the|
|00000a30| 20 69 74 65 6d 27 73 20 | 6e 61 6d 65 2e 0d 0d 5c | item's |name...\|
|00000a40| 62 65 67 69 6e 7b 64 61 | 74 61 64 65 73 63 7d 7b |begin{da|tadesc}{|
|00000a50| 63 61 6e 73 69 7a 65 7d | 0d 54 68 65 20 64 65 66 |cansize}|.The def|
|00000a60| 61 75 6c 74 20 63 61 6e | 20 73 69 7a 65 2c 20 69 |ault can| size, i|
|00000a70| 6e 20 6f 75 6e 63 65 73 | 2e 20 20 4c 65 67 61 6c |n ounces|.  Legal|
|00000a80| 20 76 61 6c 75 65 73 20 | 61 72 65 20 37 20 61 6e | values |are 7 an|
|00000a90| 64 20 31 32 2e 20 20 54 | 68 65 0d 64 65 66 61 75 |d 12.  T|he.defau|
|00000aa0| 6c 74 20 76 61 72 69 65 | 73 20 70 65 72 20 73 75 |lt varie|s per su|
|00000ab0| 70 65 72 6d 61 72 6b 65 | 74 2e 20 20 54 68 69 73 |permarke|t.  This|
|00000ac0| 20 76 61 72 69 61 62 6c | 65 20 73 68 6f 75 6c 64 | variabl|e should|
|00000ad0| 20 6e 6f 74 20 62 65 20 | 63 68 61 6e 67 65 64 0d | not be |changed.|
|00000ae0| 6f 6e 63 65 20 74 68 65 | 20 5c 63 6f 64 65 7b 6f |once the| \code{o|
|00000af0| 70 65 6e 28 29 7d 20 66 | 75 6e 63 74 69 6f 6e 20 |pen()} f|unction |
|00000b00| 68 61 73 20 62 65 65 6e | 20 63 61 6c 6c 65 64 2e |has been| called.|
|00000b10| 0d 5c 65 6e 64 7b 64 61 | 74 61 64 65 73 63 7d 0d |.\end{da|tadesc}.|
|00000b20| 0d 25 20 2d 2d 2d 20 33 | 2e 34 2e 20 2d 2d 2d 0d |.% --- 3|.4. ---.|
|00000b30| 25 20 45 78 63 65 70 74 | 69 6f 6e 73 20 61 72 65 |% Except|ions are|
|00000b40| 20 64 65 73 63 72 69 62 | 65 64 20 75 73 69 6e 67 | describ|ed using|
|00000b50| 20 61 20 60 60 65 78 63 | 64 65 73 63 27 27 20 62 | a ``exc|desc'' b|
|00000b60| 6c 6f 63 6b 2e 20 20 54 | 68 69 73 20 68 61 73 20 |lock.  T|his has |
|00000b70| 6f 6e 6c 79 0d 25 20 6f | 6e 65 20 70 61 72 61 6d |only.% o|ne param|
|00000b80| 65 74 65 72 3a 20 74 68 | 65 20 65 78 63 65 70 74 |eter: th|e except|
|00000b90| 69 6f 6e 20 6e 61 6d 65 | 2e 0d 0d 5c 62 65 67 69 |ion name|...\begi|
|00000ba0| 6e 7b 65 78 63 64 65 73 | 63 7d 7b 65 72 72 6f 72 |n{excdes|c}{error|
|00000bb0| 7d 0d 45 78 63 65 70 74 | 69 6f 6e 20 72 61 69 73 |}.Except|ion rais|
|00000bc0| 65 64 20 77 68 65 6e 20 | 61 6e 20 6f 70 65 72 61 |ed when |an opera|
|00000bd0| 74 69 6f 6e 20 66 61 69 | 6c 73 20 66 6f 72 20 61 |tion fai|ls for a|
|00000be0| 20 53 70 61 6d 20 73 70 | 65 63 69 66 69 63 20 72 | Spam sp|ecific r|
|00000bf0| 65 61 73 6f 6e 2e 0d 54 | 68 65 20 65 78 63 65 70 |eason..T|he excep|
|00000c00| 74 69 6f 6e 20 61 72 67 | 75 6d 65 6e 74 20 69 73 |tion arg|ument is|
|00000c10| 20 61 20 73 74 72 69 6e | 67 20 64 65 73 63 72 69 | a strin|g descri|
|00000c20| 62 69 6e 67 20 74 68 65 | 20 72 65 61 73 6f 6e 20 |bing the| reason |
|00000c30| 6f 66 20 74 68 65 0d 66 | 61 69 6c 75 72 65 2e 0d |of the.f|ailure..|
|00000c40| 5c 65 6e 64 7b 65 78 63 | 64 65 73 63 7d 0d 0d 25 |\end{exc|desc}..%|
|00000c50| 20 2d 2d 2d 2d 20 33 2e | 35 2e 20 2d 2d 2d 2d 0d | ---- 3.|5. ----.|
|00000c60| 25 20 54 68 65 72 65 20 | 69 73 20 6e 6f 20 73 74 |% There |is no st|
|00000c70| 61 6e 64 61 72 64 20 62 | 6c 6f 63 6b 20 74 79 70 |andard b|lock typ|
|00000c80| 65 20 66 6f 72 20 63 6c | 61 73 73 65 73 2e 20 20 |e for cl|asses.  |
|00000c90| 49 20 67 65 6e 65 72 61 | 6c 6c 79 20 75 73 65 0d |I genera|lly use.|
|00000ca0| 25 20 60 60 66 75 6e 63 | 64 65 73 63 27 27 20 62 |% ``func|desc'' b|
|00000cb0| 6c 6f 63 6b 73 2c 20 73 | 69 6e 63 65 20 63 6c 61 |locks, s|ince cla|
|00000cc0| 73 73 20 69 6e 73 74 61 | 6e 74 69 61 74 69 6f 6e |ss insta|ntiation|
|00000cd0| 20 6c 6f 6f 6b 73 20 76 | 65 72 79 20 6d 75 63 68 | looks v|ery much|
|00000ce0| 20 6c 69 6b 65 0d 25 20 | 61 20 66 75 6e 63 74 69 | like.% |a functi|
|00000cf0| 6f 6e 20 63 61 6c 6c 2e | 0d 0d 0d 25 20 3d 3d 3d |on call.|...% ===|
|00000d00| 3d 20 34 2e 20 3d 3d 3d | 3d 0d 25 20 4e 6f 77 20 |= 4. ===|=.% Now |
|00000d10| 69 73 20 70 72 6f 62 61 | 62 6c 79 20 61 20 67 6f |is proba|bly a go|
|00000d20| 6f 64 20 74 69 6d 65 20 | 66 6f 72 20 61 20 63 6f |od time |for a co|
|00000d30| 6d 70 6c 65 74 65 20 65 | 78 61 6d 70 6c 65 2e 20 |mplete e|xample. |
|00000d40| 20 28 41 6c 74 65 72 6e | 61 74 69 76 65 6c 79 2c | (Altern|atively,|
|00000d50| 0d 25 20 61 6e 20 65 78 | 61 6d 70 6c 65 20 67 69 |.% an ex|ample gi|
|00000d60| 76 69 6e 67 20 74 68 65 | 20 66 6c 61 76 6f 72 20 |ving the| flavor |
|00000d70| 6f 66 20 74 68 65 20 6d | 6f 64 75 6c 65 20 6d 61 |of the m|odule ma|
|00000d80| 79 20 62 65 20 67 69 76 | 65 6e 20 62 65 66 6f 72 |y be giv|en befor|
|00000d90| 65 20 74 68 65 0d 25 20 | 64 65 74 61 69 6c 65 64 |e the.% |detailed|
|00000da0| 20 6c 69 73 74 20 6f 66 | 20 66 75 6e 63 74 69 6f | list of| functio|
|00000db0| 6e 73 2e 29 0d 0d 45 78 | 61 6d 70 6c 65 3a 0d 0d |ns.)..Ex|ample:..|
|00000dc0| 5c 62 65 67 69 6e 7b 76 | 65 72 62 61 74 69 6d 7d |\begin{v|erbatim}|
|00000dd0| 0d 3e 3e 3e 20 69 6d 70 | 6f 72 74 20 73 70 61 6d |.>>> imp|ort spam|
|00000de0| 0d 3e 3e 3e 20 63 61 6e | 20 3d 20 73 70 61 6d 2e |.>>> can| = spam.|
|00000df0| 6f 70 65 6e 28 27 2f 65 | 74 63 2f 70 61 73 73 77 |open('/e|tc/passw|
|00000e00| 64 27 29 0d 3e 3e 3e 20 | 63 61 6e 2e 65 6d 70 74 |d').>>> |can.empt|
|00000e10| 79 28 29 0d 3e 3e 3e 20 | 63 61 6e 2e 63 6c 6f 73 |y().>>> |can.clos|
|00000e20| 65 28 29 0d 5c 65 6e 64 | 7b 76 65 72 62 61 74 69 |e().\end|{verbati|
|00000e30| 6d 7d 0d 0d 25 20 3d 3d | 3d 3d 20 35 2e 20 3d 3d |m}..% ==|== 5. ==|
|00000e40| 3d 3d 0d 25 20 49 66 20 | 79 6f 75 72 20 6d 6f 64 |==.% If |your mod|
|00000e50| 75 6c 65 20 64 65 66 69 | 6e 65 73 20 6e 65 77 20 |ule defi|nes new |
|00000e60| 6f 62 6a 65 63 74 20 74 | 79 70 65 73 20 28 66 6f |object t|ypes (fo|
|00000e70| 72 20 61 20 62 75 69 6c | 74 2d 69 6e 20 6d 6f 64 |r a buil|t-in mod|
|00000e80| 75 6c 65 29 20 6f 72 0d | 25 20 63 6c 61 73 73 65 |ule) or.|% classe|
|00000e90| 73 20 28 66 6f 72 20 61 | 20 6d 6f 64 75 6c 65 20 |s (for a| module |
|00000ea0| 77 72 69 74 74 65 6e 20 | 69 6e 20 50 79 74 68 6f |written |in Pytho|
|00000eb0| 6e 29 2c 20 79 6f 75 20 | 73 68 6f 75 6c 64 20 6c |n), you |should l|
|00000ec0| 69 73 74 20 74 68 65 0d | 25 20 6d 65 74 68 6f 64 |ist the.|% method|
|00000ed0| 73 20 61 6e 64 20 69 6e | 73 74 61 6e 63 65 20 76 |s and in|stance v|
|00000ee0| 61 72 69 61 62 6c 65 73 | 20 28 69 66 20 61 6e 79 |ariables| (if any|
|00000ef0| 29 20 6f 66 20 65 61 63 | 68 20 74 79 70 65 20 6f |) of eac|h type o|
|00000f00| 72 20 63 6c 61 73 73 20 | 69 6e 20 61 0d 25 20 73 |r class |in a.% s|
|00000f10| 65 70 61 72 61 74 65 20 | 73 75 62 73 65 63 74 69 |eparate |subsecti|
|00000f20| 6f 6e 2e 20 20 49 74 20 | 69 73 20 69 6d 70 6f 72 |on.  It |is impor|
|00000f30| 74 61 6e 74 20 74 6f 20 | 72 65 64 65 66 69 6e 65 |tant to |redefine|
|00000f40| 20 60 60 69 6e 64 65 78 | 73 75 62 69 74 65 6d 27 | ``index|subitem'|
|00000f50| 27 0d 25 20 66 6f 72 20 | 65 61 63 68 20 73 75 62 |'.% for |each sub|
|00000f60| 73 65 63 74 69 6f 6e 2e | 0d 0d 5c 73 75 62 73 65 |section.|..\subse|
|00000f70| 63 74 69 6f 6e 7b 53 70 | 61 6d 20 4f 62 6a 65 63 |ction{Sp|am Objec|
|00000f80| 74 73 7d 0d 0d 53 70 61 | 6d 20 6f 62 6a 65 63 74 |ts}..Spa|m object|
|00000f90| 73 20 28 72 65 74 75 72 | 6e 65 64 20 62 79 20 5c |s (retur|ned by \|
|00000fa0| 63 6f 64 65 7b 6f 70 65 | 6e 28 29 7d 20 61 62 6f |code{ope|n()} abo|
|00000fb0| 76 65 29 20 68 61 76 65 | 20 74 68 65 20 66 6f 6c |ve) have| the fol|
|00000fc0| 6c 6f 77 69 6e 67 0d 6d | 65 74 68 6f 64 73 2e 0d |lowing.m|ethods..|
|00000fd0| 0d 5c 72 65 6e 65 77 63 | 6f 6d 6d 61 6e 64 7b 5c |.\renewc|ommand{\|
|00000fe0| 69 6e 64 65 78 73 75 62 | 69 74 65 6d 7d 7b 28 73 |indexsub|item}{(s|
|00000ff0| 70 61 6d 20 6d 65 74 68 | 6f 64 29 7d 0d 0d 5c 62 |pam meth|od)}..\b|
|00001000| 65 67 69 6e 7b 66 75 6e | 63 64 65 73 63 7d 7b 65 |egin{fun|cdesc}{e|
|00001010| 6d 70 74 79 7d 7b 7d 0d | 45 6d 70 74 79 20 74 68 |mpty}{}.|Empty th|
|00001020| 65 20 63 61 6e 20 69 6e | 74 6f 20 74 68 65 20 74 |e can in|to the t|
|00001030| 72 61 73 68 2e 0d 5c 65 | 6e 64 7b 66 75 6e 63 64 |rash..\e|nd{funcd|
|00001040| 65 73 63 7d 0d          |                         |esc}.   |        |
+--------+-------------------------+-------------------------+--------+--------+